Getting started with the APIs
==============================

We provide API access to clients for document OCR and Government verification. You are requested to integrate in our Test Mode first, and test the integration, before shifting to Live Mode.

Defining internal objects
--------------------------

.. list-table::
   :widths: 30 70
   :header-rows: 1

   * - Objects
     - Responses
   * - **person**
     - We define person as an entity on our side, which is used to track/upload/verify document against.
   * - **document**
     - We define document as an entity to be verified/OCR ed.
   * - **User**
     - We define User as an entity having group of people.
   * - **Company**
     - We define Company as an entity having group of users.

API Headers
-----------

.. list-table::
   :widths: 30 70
   :header-rows: 1

   * - Objects
     - Responses
   * - **api_action**
     - Denotes the activity that would be performed through APi which in this case can be OCR, verification and Aadhar Masking
   * - **docType**
     - The name of document which was provided to API eg. ind_aadhar, ind_pan etc..
   * - **api_doc_face**
     - Applicable only for OCR API and represents whether front or both sides urls of Ids were provided.
   * - **api_status**
     - Represents the whether API call was successful or failure.
   * - **api_status_code**
     - Denotes the code (Numeric) for the associated status while running API.
   * - **api_status_description**
     - A detailed message about the api_status .
   * - **request_id**
     - Unique number associated to each API call .
   * - **created_at**
     - date & timestamp denoting the beginning of API call.
   * - **completed_at**
     - date & timestamp denoting the end of API call.
   * - **person_id**
     - Unique entity number used internally that is used to track/upload/verify documents against an individual.

Success Parameters
-------------------

Integrating an API for OCR or Government Verification has results which would either match the details from government sources or provide other related details. The application of these results are subjective and we give you the authority to decide your success criteria.

**Use Case**: Through Aadhar verification you want to verify the Id number and name of the card holder. This criteria can be set by choosing the appropriate success parameters from the available list for Aadhar. So your check status will be true only if the Id number and name from the ID matches with the government source.

.. list-table::
   :widths: 30 70
   :header-rows: 1

   * - Field Name
     - Description
   * - **name_match_threshold**
     - Denotes the precision so which any alphanumeric value can be matched with source. The value ranges from 0 - 100. Default value is 70
   * - **success_parameters**
     - Name of parameters which define the success criteria for check.
   * - **success_config_description**
     - Detailed message with name of success parameters chosen as success criteria.

Supported Document Types
-------------------------

Version 1
+++++++++

.. list-table::
   :widths: 25 25 15 20
   :header-rows: 1

   * - Document
     - Key
     - OCR
     - Verification
   * - Pan
     - ind_pan
     - Yes
     - Yes
   * - Voter Id
     - ind_voter_id
     - Yes
     - Yes
   * - Aadhar
     - ind_aadhaar
     - Yes
     - Yes
   * - Passport
     - ind_passport
     - Yes
     - Yes
   * - Driving License
     - ind_driving_license
     - Yes
     - Yes
   * - GST Certificate
     - ind_gst_certificate
     - No
     - Yes
   * - RC Book
     - ind_rc
     - No
     - Yes
   * - COA
     - ind_coa
     - No
     - Yes
   * - MCA (CIN/DIN)
     - ind_mca
     - No
     - Yes
   * - Pan KRA
     - pan_kyc
     - No
     - Yes
   * - Udyog
     - udyog_aadhaar
     - No
     - Yes
   * - Udyam
     - ind_udyam
     - No
     - Yes
   * - LIN/Shram Suvidha
     - ind_lin
     - No
     - Yes

Version 2
+++++++++

.. list-table::
   :widths: 25 25 15 20
   :header-rows: 1

   * - Document
     - Key
     - OCR
     - Verification
   * - Pan
     - ind_pan
     - Yes
     - Yes
   * - Voter Id
     - ind_voter_id
     - Yes
     - Yes
   * - Aadhar
     - ind_aadhaar
     - Yes
     - Yes
   * - Passport
     - ind_passport
     - Yes
     - Yes
   * - Driving License
     - ind_driving_license
     - Yes
     - Yes
   * - Udyam
     - ind_udyam
     - No
     - Yes
   * - LIN/Shram Suvidha
     - ind_lin
     - No
     - Yes

Environment URL's
-----------------

Development:
++++++++++++

**Endpoint** - https://api-dev.springscan.springverify.com

**Token** - 4cbe51cf-a294-35a8-b3ae-d3cc89abf29c

Production:
+++++++++++

**Endpoint** - https://api.springscan.springverify.com

**Token** - ( Contact sales@springworks.in )

Postman
+++++++

**Run in Postman**

User can signup on the dashboard and get their credentials or can contact us for the same.

.. note::
   Email us for access